package org.tangerinejunction.imstats.util;

/**
 * The increments used in trend analyses.  This class predefines
 * several commonly used increments: day, week, month, year.
 * 
 * @author meganthorsen
 */
public class Increment
{
	/*
	 * Several commonly used increments
	 */
	public static final Increment DAY = new Increment("Day", 1, 0, 0);
	public static final Increment WEEK = new Increment("Week", 7, 0, 0);
	public static final Increment MONTH = new Increment("Month", 0, 1, 0);
	public static final Increment YEAR = new Increment("Year", 0, 0, 1);
	
	String name;
	public int numDays;
	public int numMonths;
	public int numYears;
	
	/**
	 * 
	 * @param name		the name of the Increment
	 * @param numDays	the number of days in the Increment
	 * @param numMonths	the number of months in the Increment
	 * @param numYears	the number of years in the Increment
	 */
	public Increment(String name, int numDays, int numMonths, int numYears)
	{
		this.name = name;
		this.numDays = numDays;
		this.numMonths = numMonths;
		this.numYears = numYears;
	}
	
	public String toString()
	{
		return name;
	}
}
